<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: VaadinApplicationScope.html 883 2014-05-07 02:45:34Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.server.SessionDestroyEvent;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.server.SessionDestroyListener;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.vaadin.server.VaadinSession;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.util.HashMap;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.springframework.beans.factory.ObjectFactory;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.springframework.beans.factory.config.BeanFactoryPostProcessor;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.springframework.beans.factory.config.Scope;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * A Spring custom {@link Scope} for Vaadin applications.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * This scopes beans to the lifetime of the {@link VaadinSession} (formerly known as "Vaadin application").<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Spring {@linkplain org.springframework.beans.factory.DisposableBean#destroy destroy-methods}<a name="line.26"></a>
<span class="sourceLineNo">027</span> * will be invoked when the {@link VaadinSession} is closed.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * To enable this scope, simply add this bean to your application context as a singleton (it will register itself):<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> *  &amp;lt;!-- Enable the "vaadinApplication" custom scope --&amp;gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  &amp;lt;bean class="org.dellroad.stuff.vaadin7.VaadinApplicationScope"/&amp;gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Then declare scoped beans normally using the scope name {@code "vaadinApplication"}.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@SuppressWarnings("serial")<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class VaadinApplicationScope implements Scope, BeanFactoryPostProcessor, SessionDestroyListener {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Key to the current {@link VaadinSession} instance. For use by {@link #resolveContextualObject}.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     */<a name="line.44"></a>
<span class="sourceLineNo">045</span>    public static final String VAADIN_SERVICE_SESSION_KEY = "vaadinServiceSession";<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * The name of this scope (i.e., &lt;code&gt;{@value}&lt;/code&gt;).<a name="line.48"></a>
<span class="sourceLineNo">049</span>     */<a name="line.49"></a>
<span class="sourceLineNo">050</span>    public static final String SCOPE_NAME = "vaadinApplication";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    private final HashMap&lt;VaadinSession, SessionBeanHolder&gt; beanHolders = new HashMap&lt;&gt;();<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>// BeanFactoryPostProcessor methods<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        beanFactory.registerScope(VaadinApplicationScope.SCOPE_NAME, this);<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>// SessionDestroyListener<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    @Override<a name="line.63"></a>
<span class="sourceLineNo">064</span>    public void sessionDestroy(SessionDestroyEvent event) {<a name="line.64"></a>
<span class="sourceLineNo">065</span>        final VaadinSession session = event.getSession();<a name="line.65"></a>
<span class="sourceLineNo">066</span>        SessionBeanHolder beanHolder;<a name="line.66"></a>
<span class="sourceLineNo">067</span>        synchronized (this) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>            beanHolder = this.beanHolders.remove(session);<a name="line.68"></a>
<span class="sourceLineNo">069</span>        }<a name="line.69"></a>
<span class="sourceLineNo">070</span>        if (beanHolder != null)<a name="line.70"></a>
<span class="sourceLineNo">071</span>            beanHolder.close();<a name="line.71"></a>
<span class="sourceLineNo">072</span>    }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>// Scope methods<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span>    public synchronized Object get(String name, ObjectFactory&lt;?&gt; objectFactory) {<a name="line.77"></a>
<span class="sourceLineNo">078</span>        return this.getSessionBeanHolder(true).getBean(name, objectFactory);<a name="line.78"></a>
<span class="sourceLineNo">079</span>    }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>    @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span>    public synchronized Object remove(String name) {<a name="line.82"></a>
<span class="sourceLineNo">083</span>        SessionBeanHolder beanHolder = this.getSessionBeanHolder(false);<a name="line.83"></a>
<span class="sourceLineNo">084</span>        return beanHolder != null ? beanHolder.remove(name) : null;<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    @Override<a name="line.87"></a>
<span class="sourceLineNo">088</span>    public synchronized void registerDestructionCallback(String name, Runnable callback) {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        this.getSessionBeanHolder(true).registerDestructionCallback(name, callback);<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    @Override<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public String getConversationId() {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        VaadinSession session = VaadinSession.getCurrent();<a name="line.94"></a>
<span class="sourceLineNo">095</span>        if (session == null)<a name="line.95"></a>
<span class="sourceLineNo">096</span>            return null;<a name="line.96"></a>
<span class="sourceLineNo">097</span>        return session.getClass().getName() + "@" + System.identityHashCode(session);<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span>    public Object resolveContextualObject(String key) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>        if (VAADIN_SERVICE_SESSION_KEY.equals(key))<a name="line.102"></a>
<span class="sourceLineNo">103</span>            return VaadinSession.getCurrent();<a name="line.103"></a>
<span class="sourceLineNo">104</span>        return null;<a name="line.104"></a>
<span class="sourceLineNo">105</span>    }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>// Internal methods<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>    private synchronized SessionBeanHolder getSessionBeanHolder(boolean create) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>        VaadinSession session = VaadinUtil.getCurrentSession();<a name="line.110"></a>
<span class="sourceLineNo">111</span>        VaadinUtil.addSessionDestroyListener(session, this);<a name="line.111"></a>
<span class="sourceLineNo">112</span>        SessionBeanHolder beanHolder = this.beanHolders.get(session);<a name="line.112"></a>
<span class="sourceLineNo">113</span>        if (beanHolder == null &amp;&amp; create) {<a name="line.113"></a>
<span class="sourceLineNo">114</span>            beanHolder = new SessionBeanHolder();<a name="line.114"></a>
<span class="sourceLineNo">115</span>            this.beanHolders.put(session, beanHolder);<a name="line.115"></a>
<span class="sourceLineNo">116</span>        }<a name="line.116"></a>
<span class="sourceLineNo">117</span>        return beanHolder;<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>// Bean holder class corresponding to a single Application instance<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>    private static class SessionBeanHolder {<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>        private final HashMap&lt;String, Object&gt; beans = new HashMap&lt;&gt;();<a name="line.124"></a>
<span class="sourceLineNo">125</span>        private final HashMap&lt;String, Runnable&gt; destructionCallbacks = new HashMap&lt;&gt;();<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>        public Object getBean(String name, ObjectFactory&lt;?&gt; objectFactory) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>            Object bean = this.beans.get(name);<a name="line.128"></a>
<span class="sourceLineNo">129</span>            if (bean == null) {<a name="line.129"></a>
<span class="sourceLineNo">130</span>                bean = objectFactory.getObject();<a name="line.130"></a>
<span class="sourceLineNo">131</span>                this.beans.put(name, bean);<a name="line.131"></a>
<span class="sourceLineNo">132</span>            }<a name="line.132"></a>
<span class="sourceLineNo">133</span>            return bean;<a name="line.133"></a>
<span class="sourceLineNo">134</span>        }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span>        public Object remove(String name) {<a name="line.136"></a>
<span class="sourceLineNo">137</span>            this.destructionCallbacks.remove(name);<a name="line.137"></a>
<span class="sourceLineNo">138</span>            return this.beans.remove(name);<a name="line.138"></a>
<span class="sourceLineNo">139</span>        }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>        public void registerDestructionCallback(String name, Runnable callback) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>            this.destructionCallbacks.put(name, callback);<a name="line.142"></a>
<span class="sourceLineNo">143</span>        }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>        public void close() {<a name="line.145"></a>
<span class="sourceLineNo">146</span>            for (Runnable callback : this.destructionCallbacks.values())<a name="line.146"></a>
<span class="sourceLineNo">147</span>                callback.run();<a name="line.147"></a>
<span class="sourceLineNo">148</span>            this.beans.clear();<a name="line.148"></a>
<span class="sourceLineNo">149</span>            this.destructionCallbacks.clear();<a name="line.149"></a>
<span class="sourceLineNo">150</span>        }<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span>}<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>




























































</pre>
</div>
</body>
</html>
